Assurance API
Test Cases
See Summary under the API specification for the API base URI.
If there are additional test cases you would like included here, please inform API Support for future consideration.
Product
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
|---|---|---|---|
| 1. | Get Product | Submit a GET Product request for a layer two NGA fibre product instance. | The API will return a 200 response code and applicable product details including the OLT, ONT and Plan objects. |
| 2. | Get Product | Submit a GET Product request for a copper broadband product instance. | The API will return a 200 response code and product details including where applicable the DLSAM object. |
| 3. | Get Product | Submit a GET Product request for a copper voice product instance. | The API will return a 200 response code, and the voice product details. |
| 4. | Get Product | Submit a GET Product request for a validated complex product instance. - HSNS - UCLL Backhaul | The API will return a 200 response code and product details including where applicable the ComplexService object. |
| 5. | Get Product | Submit a GET Product request for an unvalidated complex product instance. - Co- location - NGA Layer One | The API will return a 299 response code and available product details including the UnvalidatedProduct object and UnvalidatedProductTypeIdentifier object. |
| 6. | Get Product | Submit a GET Product request for an NGA RGW service for it’s the following service instance details: - Wi-Fi | The API will return the Wi-Fi instance details for its two port indexes that operate at 2.4GHz (port index 1) and 5GHz (port index 5). |
| 7. | Get Product | Submit a GET Product request for an NGA RGW service for it’s following service instance details: - Wi-Fi - WAN - LAN & Voice - Connected hosts | The API will return the following: - For Wi-Fi instance: It will supply details for its two port indexes that operate at 2.4GHz (port index 1) and 5GHz (port index 5) - For WAN instance: It will supply details of the WAN configuration - For LAN & Voice instance: It will supply details of Ethernet and Voice ports - Details of hosts connected to Wi-Fi or Ethernet ports |
| 8. | Put Product | Submit a PUT request to configure the NGA RGW service for the following service instance details: - Wi-Fi - WAN - LAN & Voice | The API will return if the configuration could be applied or not. |
Diagnostics
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
|---|---|---|---|
| 1. | Post Session | Submit a POST session request for a diagnostic for a validated product. | The API will return a 200 response code and a payload including a GUID session identifier and session status. |
| 2. | Post Session | Submit a POST session request for a diagnostic for an unvalidated product. | The API will return a 299 response code and a payload including a GUID identifier and applicable fault types. |
| 3. | Query Session | Submit a request to return all Diagnostic Sessions which have a specific product id. | The API will return all diagnostic sessions associated with the specified Product Id. |
| 4. | Query Session | Submit a request to return all Diagnostic Sessions which have a given status. | The API will return all diagnostic sessions which have the given status. |
| 5. | Get Session | Submit a request to retrieve a diagnostic session for a copper Voice product. - Home Line - Business Line | The API will return a 200 response code. Where the diagnostic is complete the payload will include, Single line test results, fault types applicable to the product and next steps. Where the diagnostic is not complete the payload will include a GUID session identifier and session status. |
| 6. | Get Session | Submit a request to retrieve a diagnostic session for a Baseband IP product. (BBIP) | The API will return a 200 response code. Where the diagnostic is complete the payload will include, electrical loop test results, fault types applicable to the product and next steps. Where the diagnostic is not complete the payload will include a GUID session identifier and session status. |
| 7. | Get Session | Submit a request to retrieve a diagnostic session for a copper broadband product. - VDSL - Enhanced EUBA | The API will return a 200 response code. Where the diagnostic is complete the payload will include, Line state diagnostics test results, fault types applicable to the product and next steps. Where the diagnostic is not complete the payload will include a GUID session identifier and session status. |
| 8. | Get Session | Submit a request to retrieve a diagnostic session for a layer two NGA fibre product. - NGA Bitstream 3/3a - NGA Bitstream 4 | The API will return a 200 response code. Where the diagnostic is complete the payload will include, ONT status test results, fault types applicable to the product and next steps. Where the diagnostic is not complete the payload will include a GUID session identifier and session status. |
| 9. | Get Session | Submit a request to retrieve a diagnostic results for an NGA RGW test type that may be of type: - Wi-Fi Information - WAN Information - LAN & Voice Ports Information | For each of the diagnostic tests, the API will return the following details: - Overall Wi-Fi/WAN/LAN & Voice ports status will be identified and summarised - Configuration and diagnostic status of each Wi-Fi/Ethernet/Voice port index - The statistics of packets, bytes and errors sent since the RGW counters were initiated/reset - The number of packets, bytes and errors sent during the each test duration |
| 10. | Post Fault Type | Submit a POST request to update a fault type for a diagnostics session for a product. | The API will return fault types with their associated work divisions. |
| 11. | Get Schedule | Submit a request to retrieve a schedule for a layer two product. | The API will return the applicable schedule for the layer two products. |
| 12. | Get Schedule | Submit a request to retrieve a schedule for a layer one UCLL product. | The API will return the schedule for layer one UCLL products. |
| 13. | Get Schedule | Submit a request to retrieve a schedule for a layer one Non UCLL product. | The API will return an error code. Schedules not found for given query parameters. |
| 14. | Get Schedule | Submit a request for a validated product without a selected appointment. | The API will return an error code. Invalid Problem Report Submission - Appointment Booking Required. |
Submit Problem Report
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
|---|---|---|---|
| 1. | POST Problem Report | Submit a POST problem report request for a product instance. | The API will return all the details required for submission of a problem report including mandatory and not mandatory question sets, address details, site contact details, trading details for businesses and appointment details where applicable. |
Manage Problem Reports
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
|---|---|---|---|
| 1. | Get Problem Reports | Submit a query to Retrieve a set of problem reports based on one of the following statuses. Accepted, Assigned, Open, Scheduled, Completed, Request for information, In Progress, Pending Cancel, Service Given, Closed. | The API will return a 200 response code and a set of problem reports based on the status provided. Results will be paginated to the number specified in the input. |
| 2. | Get Problem Reports | Submit a query to retrieve a set of problem reports excluding one of the following statuses using notStatus. Accepted, Assigned, Open, Scheduled, Completed, Request for information, In Progress, Pending Cancel, Service Given, Closed. | The API will return a 200 response code and a set of problem reports excluding the status specified. Results will be paginated to the number specified in the input. |
| 3. | Get Problem Report | Submit a request to retrieve a problem report. | The API will return a 200 response code and the problem report specified in the input including updates. |
| 4. | Put Problem Report | Submit a request to Amend a problem report. | The API will return a 200 response code and the editable input fields for the problem report. |
| 5. | Close Problem Report | Submit a request to Close a Problem Report. | The API will return a 200 response code and the SubmitCloseProblem report object. |
| 6. | Cancel Problem Report | Submit a request to Cancel a Problem Report. | The API will return a 200 response code and the SubmitCancelProblem report object. |
| 7. | Update Problem Report | Submit a request to Update a Problem Report. | The API will return a 200 response code and the SubmitUpdateProblem report object. |
Events
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
|---|---|---|---|
| 1. | Get Events | Retrieve events impacting your service | The API will return a list of future planned, current and recent planned and unplanned events that impact the service. |
| 2. | Get Events | Retrieve events impacted by an outage on a particular Chorus network element id. | The API will return a list of future planned, current and recent planned and unplanned events, which are impacted by an outage of the specified network element for which the services are impacted. |
| 3. | Get Events | Retrieve events with a matching service id that impact a Service Provider’s service. | The API will return a list of events which are expected to, or have impacted a specified service. |
| 4. | Get Events | Retrieve full event details. | The API will return full event details for the specified event (identified by Chorus event id). |
| 5. | Get Impact | Retrieve services impacted by an event. | The API will return links that allow subsequent download of most recent services impact notifications provided for given event, by organisation and impact type. |